GET api/SIMS/GetResourcesByReplicIdsAndFileExtensions?startReplicId={startReplicId}&endReplicId={endReplicId}&fileExtensions[0]={fileExtensions[0]}&fileExtensions[1]={fileExtensions[1]}&companyKey={companyKey}

Gets a list of resources in the database according to a range of ReplicIds and file extensions. The resources retrieved will have their ReplicId between the ones specified, including both the start and end IDs. The file extensions is optional and if left empty will retrieve all of the items regardless of extension.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
startReplicId

The first ReplicId to get the resources for

 string

Required
endReplicId

The last ReplicId to get the resources for

 string

Required
fileExtensions

List of specific file extensions (ex. jpg, png, etc.) to retrieve (Optional)

 Collection of string

Required
companyKey

The company key if the service is connected to multiple SIMS companies (Optional)

 string

Default value is

Body Parameters

N/A


Response Information

Resource Description

List of resources which are in the database according to the parameters provided

Collection of ResourceImages
NameDescriptionTypeAdditional information
Iid

The ID of the resource in the database for uniqueness

 string

N/A
StockCode

The stock code of the stock ext web

 string

N/A
ResourceId

The resource ID set by the user

 string

N/A
DispOrd

The display order field

 string

N/A
StockReplicId

The replic ID of the Stk_Resx table

 string

N/A
Content

The content of the resource

 string

N/A
Extension

The extension of the resource

 string

N/A
Remarks

Any remarks which belong to the resource

 string

N/A
Embedded

Boolean check on whether the resource is embedded or not

 boolean

N/A
Signature

The signature of the resource

 string

N/A
ResourceReplicId

The replic ID belonging to the resource in the resource table

 string

N/A
FileName

The file name of the resource

 string

N/A
FileInBase64StringFormat

The file in the format of Base64 String

 string

N/A

Response Formats

application/json, text/json

Sample: 
[
  {
    "Iid": "sample string 1",
    "StockCode": "sample string 2",
    "ResourceId": "sample string 3",
    "DispOrd": "sample string 4",
    "StockReplicId": "sample string 5",
    "Content": "sample string 6",
    "Extension": "sample string 7",
    "Remarks": "sample string 8",
    "Embedded": true,
    "Signature": "sample string 10",
    "ResourceReplicId": "sample string 11",
    "FileName": "sample string 12",
    "FileInBase64StringFormat": "sample string 13"
  },
  {
    "Iid": "sample string 1",
    "StockCode": "sample string 2",
    "ResourceId": "sample string 3",
    "DispOrd": "sample string 4",
    "StockReplicId": "sample string 5",
    "Content": "sample string 6",
    "Extension": "sample string 7",
    "Remarks": "sample string 8",
    "Embedded": true,
    "Signature": "sample string 10",
    "ResourceReplicId": "sample string 11",
    "FileName": "sample string 12",
    "FileInBase64StringFormat": "sample string 13"
  }
]